/* Gauge - Performance Measurement Framework for Mobile Platforms
 * Copyright (C) 2013, Juha Hytonen <juha.a.hytonen@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.gauge;

/** 
 * Produces measurements by observing the benchmarked system.
 */
public interface Probe {

    /** 
     * A STATIC probe produces a single value during the execution of
     * the benchmark. An example static probe could produce the amount of RAM
     * installed in the system.
     * 
     * A DYNAMIC probe changes its value during the execution of the 
     * benchmark; typically depending on the workload. An example dynamic
     * probe could produce the memory usage of a process.
     */
    public enum Type { Static, Dynamic };

    public Type GetType();

    public String GetName();

    public Measurement GetMeasurement() throws Exception;

}